Fix duplicate docstring attributes in Measurement and Exemplar classes#4920
Merged
xrmx merged 2 commits intoopen-telemetry:mainfrom Mar 13, 2026
Merged
Conversation
|
|
tammy-baylis-swi
added
the
Skip Changelog
tammy-baylis-swi
approved these changes
Feb 18, 2026
Contributor
tammy-baylis-swi
left a comment
tammy-baylis-swi
left a comment
There was a problem hiding this comment.
Thanks for this. Maintainers will also review
tammy-baylis-swi
moved this from Ready for review
to Easy to review / merge / close
in Python PR digest
MikeGoldsmith
approved these changes
Feb 27, 2026
MikeGoldsmith
moved this from Easy to review / merge / close
to Approved PRs
in Python PR digest
xrmx
approved these changes
Mar 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes the duplicate attribute documentation caused by both
napoleonandautodocSphinx extensions processing the sameAttributes:sections in dataclass docstrings. This was flagged by TODO comments in both files referencing sphinx-doc/sphinx#8664.Changes:
docs/conf.py: Addnapoleon_use_ivar = Trueso napoleon emits:ivar:fields instead of.. attribute::directives, preventing autodoc from rendering the same attributes a second timemeasurement.py: Fix missing colon inAttributes:section and remove TODO commentexemplar.py: Fix missing colon inAttributes:section and remove TODO commentFixes # (no issue — fixing existing TODO comments in the codebase)
Type of change
How Has This Been Tested?
Ran
tox -e docsandtox -e rufflocally.tox -e ruffpasses cleanly after auto-fix of trailing whitespacetox -e docsfails on bothmainand this branch with the same pre-existing unrelated error inopentelemetry._logs._internal.LogRecord(ambiguous cross-reference forContext). This is not caused by this PR.Does This PR Require a Contrib Repo Change?
Checklist: